@supernova-studio/supernova-sdk-beta 1.6.10 → 1.6.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/sdk-typescript/src/browser-bundle.d.ts +1 -1
- package/build/sdk-typescript/src/core/SDKSupernova.d.ts +45 -39
- package/build/sdk-typescript/src/core/areas/SDKAreaAssets.d.ts +35 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaBrands.d.ts +18 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaBulkOperations.d.ts +31 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaComponents.d.ts +43 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDataSources.d.ts +18 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDesignSystems.d.ts +17 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaDocumentation.d.ts +50 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaIntegrations.d.ts +26 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaMe.d.ts +22 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaPipelines.d.ts +36 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokenValues.d.ts +140 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaTokens.d.ts +217 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaUsers.d.ts +6 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaVersions.d.ts +14 -0
- package/build/sdk-typescript/src/core/areas/SDKAreaWorkspaces.d.ts +114 -0
- package/build/sdk-typescript/src/core/areas/SDKRemoteIdentifiers.d.ts +25 -0
- package/build/sdk-typescript/src/core/data/SDKDataBridge.d.ts +16 -17
- package/build/sdk-typescript/src/core/data/SDKDataCore.d.ts +209 -134
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreReadRequests.d.ts +124 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreRenderRequests.d.ts +18 -0
- package/build/sdk-typescript/src/core/data/requests/SDKDataCoreWriteRequests.d.ts +73 -0
- package/build/sdk-typescript/src/core/errors/SDKSupernovaError.d.ts +41 -20
- package/build/sdk-typescript/src/core/resolvers/SDKAssetGroupResolver.d.ts +1 -1
- package/build/sdk-typescript/src/core/resolvers/SDKComponentGroupResolver.d.ts +13 -0
- package/build/sdk-typescript/src/core/resolvers/SDKComponentResolver.d.ts +5 -6
- package/build/sdk-typescript/src/core/resolvers/SDKDesignComponentGroupResolver.d.ts +1 -4
- package/build/sdk-typescript/src/core/resolvers/SDKDocumentationItemResolver.d.ts +6 -8
- package/build/sdk-typescript/src/core/resolvers/SDKTokenGroupResolver.d.ts +1 -2
- package/build/sdk-typescript/src/core/resolvers/SDKTokenResolver.d.ts +73 -45
- package/build/sdk-typescript/src/exports.d.ts +143 -117
- package/build/sdk-typescript/src/index.d.ts +1 -1
- package/build/sdk-typescript/src/model/acl/SDKAcl.d.ts +51 -0
- package/build/sdk-typescript/src/model/assets/SDKRenderedAsset.d.ts +5 -5
- package/build/sdk-typescript/src/model/base/SDKBrand.d.ts +30 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystem.d.ts +56 -0
- package/build/sdk-typescript/src/model/base/SDKDesignSystemVersion.d.ts +40 -0
- package/build/sdk-typescript/src/model/base/SDKDocumentation.d.ts +10 -0
- package/build/sdk-typescript/src/model/components/SDKComponent.d.ts +4 -4
- package/build/sdk-typescript/src/model/components/SDKDesignComponent.d.ts +4 -4
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationConfiguration.d.ts +5 -5
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationGroup.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationItem.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationPage.d.ts +4 -4
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageAsset.d.ts +4 -4
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationPageBlock.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichText.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpan.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/SDKDocumentationRichTextSpanAttribute.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAsset.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockAssets.d.ts +6 -8
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCallout.d.ts +5 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCode.d.ts +5 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumn.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockColumnItem.d.ts +7 -9
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockCustom.d.ts +5 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockDivider.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedFigma.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedGeneric.d.ts +5 -7
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedLink.d.ts +5 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedStorybook.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockEmbedYoutube.d.ts +1 -5
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrame.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockFrames.d.ts +6 -8
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockHeading.d.ts +5 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockImage.d.ts +5 -7
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockOrderedList.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockQuote.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockRenderCode.d.ts +3 -4
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcut.d.ts +3 -3
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockShortcuts.d.ts +5 -7
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTab.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTabItem.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTable.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableCell.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableColumn.d.ts +5 -5
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTableRow.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockText.d.ts +5 -7
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockToken.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenGroup.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockTokenList.d.ts +4 -6
- package/build/sdk-typescript/src/model/documentation/blocks/SDKDocumentationPageBlockUnorderedList.d.ts +2 -6
- package/build/sdk-typescript/src/model/documentation/builder/SDKDocumentationBlockBuilder.d.ts +1 -1
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemConfiguration.d.ts +2 -2
- package/build/sdk-typescript/src/model/documentation/configuration/SDKDocumentationItemHeader.d.ts +6 -6
- package/build/sdk-typescript/src/model/elements/SDKElementDataView.d.ts +4 -4
- package/build/sdk-typescript/src/model/elements/SDKElementDataViewColumn.d.ts +2 -2
- package/build/sdk-typescript/src/model/elements/SDKElementProperty.d.ts +23 -6
- package/build/sdk-typescript/src/model/elements/SDKElementPropertyOption.d.ts +6 -2
- package/build/sdk-typescript/src/model/elements/values/SDKElementPropertyValue.d.ts +2 -2
- package/build/sdk-typescript/src/model/enums/SDKBorderStyle.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKIntegrationService.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKTextCase.d.ts +2 -1
- package/build/sdk-typescript/src/model/enums/SDKTokenType.d.ts +42 -6
- package/build/sdk-typescript/src/model/enums/SDKUnit.d.ts +13 -2
- package/build/sdk-typescript/src/model/enums/SDKUserRole.d.ts +7 -0
- package/build/sdk-typescript/src/model/enums/SDKVisibilityType.d.ts +4 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceNPMRegistryAuthType.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceNPMRegistryType.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionPlanInterval.d.ts +6 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionProduct.d.ts +12 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatus.d.ts +18 -0
- package/build/sdk-typescript/src/model/enums/SDKWorkspaceSubscriptionStatusInternal.d.ts +8 -0
- package/build/sdk-typescript/src/model/exporters/SDKExporter.d.ts +3 -3
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlock.d.ts +2 -2
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockProperty.d.ts +2 -2
- package/build/sdk-typescript/src/model/exporters/custom_blocks/SDKExporterCustomBlockVariant.d.ts +2 -2
- package/build/sdk-typescript/src/model/exporters/custom_properties/SDKExporterConfigurationProperty.d.ts +5 -5
- package/build/sdk-typescript/src/model/groups/SDKAssetGroup.d.ts +5 -5
- package/build/sdk-typescript/src/model/groups/SDKComponentGroup.d.ts +39 -0
- package/build/sdk-typescript/src/model/groups/SDKDesignComponentGroup.d.ts +7 -7
- package/build/sdk-typescript/src/model/groups/SDKTokenGroup.d.ts +12 -11
- package/build/sdk-typescript/src/model/membership/SDKMembership.d.ts +16 -0
- package/build/sdk-typescript/src/model/support/SDKDesignComponentOrigin.d.ts +4 -4
- package/build/sdk-typescript/src/model/support/SDKFrameOrigin.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKSize.d.ts +2 -2
- package/build/sdk-typescript/src/model/support/SDKSource.d.ts +19 -9
- package/build/sdk-typescript/src/model/support/SDKTokenOrigin.d.ts +2 -2
- package/build/sdk-typescript/src/model/themes/SDKThemeUtilities.d.ts +8 -3
- package/build/sdk-typescript/src/model/themes/SDKTokenTheme.d.ts +16 -24
- package/build/sdk-typescript/src/model/themes/SDKTokenThemeOverride.d.ts +13 -21
- package/build/sdk-typescript/src/model/tokens/SDKBlurToken.d.ts +12 -8
- package/build/sdk-typescript/src/model/tokens/SDKBorderToken.d.ts +15 -10
- package/build/sdk-typescript/src/model/tokens/SDKColorToken.d.ts +19 -11
- package/build/sdk-typescript/src/model/tokens/SDKDimensionToken.d.ts +70 -0
- package/build/sdk-typescript/src/model/tokens/SDKGradientToken.d.ts +18 -10
- package/build/sdk-typescript/src/model/tokens/SDKShadowToken.d.ts +17 -13
- package/build/sdk-typescript/src/model/tokens/SDKStringToken.d.ts +36 -0
- package/build/sdk-typescript/src/model/tokens/SDKTextCaseToken.d.ts +23 -0
- package/build/sdk-typescript/src/model/tokens/SDKTextDecorationToken.d.ts +26 -0
- package/build/sdk-typescript/src/model/tokens/SDKToken.d.ts +13 -12
- package/build/sdk-typescript/src/model/tokens/SDKTokenCompator.d.ts +10 -10
- package/build/sdk-typescript/src/model/tokens/SDKTokenValue.d.ts +149 -63
- package/build/sdk-typescript/src/model/tokens/SDKTypographyToken.d.ts +12 -11
- package/build/sdk-typescript/src/model/tokens/SDKVisibilityToken.d.ts +18 -0
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenData.d.ts +74 -14
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenModel.d.ts +18 -16
- package/build/sdk-typescript/src/model/tokens/remote/SDKRemoteTokenValue.d.ts +73 -34
- package/build/sdk-typescript/src/model/users/SDKUser.d.ts +20 -11
- package/build/sdk-typescript/src/model/users/SDKUserProfile.d.ts +49 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspace.d.ts +27 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceIPWhitelistSettings.d.ts +26 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceNPMRegistrySettings.d.ts +34 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceOnboarding.d.ts +30 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProductFeatures.d.ts +30 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceProfile.d.ts +68 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSSOSettings.d.ts +17 -0
- package/build/sdk-typescript/src/model/workspaces/SDKWorkspaceSubscription.d.ts +82 -0
- package/build/sdk-typescript/src/tests/Areas/AreaTokenValues.d.ts +0 -0
- package/build/sdk-typescript/src/tests/FigmaTokensDataLoader.d.ts +20 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceNPMRegistrySettings.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceOnboarding.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Serialization/WorkspaceSSOSettings.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/PluginFigmaTokens.spec.d.ts +1 -17
- package/build/sdk-typescript/src/tests/Tooling/ReadTokens.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/Tooling/TokensModel.spec.d.ts +1 -0
- package/build/sdk-typescript/src/tests/helpers.d.ts +6 -1
- package/build/sdk-typescript/src/tests/validators.d.ts +83 -0
- package/build/sdk-typescript/src/tools/design-tokens/SDKToolsDesignTokensPlugin.d.ts +15 -13
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONConverter.d.ts +15 -12
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONGroupBuilder.d.ts +8 -6
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONLoader.d.ts +2 -1
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTJSONParser.d.ts +5 -3
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapLoader.d.ts +4 -4
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTMapResolver.d.ts +2 -5
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTThemeMerger.d.ts +7 -7
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenGroupTreeMerger.d.ts +6 -6
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenMerger.d.ts +6 -6
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenReferenceResolver.d.ts +5 -6
- package/build/sdk-typescript/src/tools/design-tokens/utilities/SDKDTTokenSetResolver.d.ts +1 -2
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTree.d.ts +4 -2
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTGroupTreeNode.d.ts +1 -4
- package/build/sdk-typescript/src/tools/design-tokens/utilities/tree/SDKDTParentChildMapping.d.ts +1 -1
- package/build/sdk-typescript/src/tools/json-builder/SDKToolsJSONBuilder.d.ts +6 -5
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementFigmaTokensTransformer.d.ts +17 -20
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementStyleDictionaryTransformer.d.ts +11 -14
- package/build/sdk-typescript/src/tools/json-builder/elements-transformers/SDKToolsJSONElementTransformer.d.ts +27 -36
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransform.d.ts +5 -6
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformBlock.d.ts +39 -39
- package/build/sdk-typescript/src/tools/markdown-transform/SDKToolsMarkdownTransformUtil.d.ts +4 -8
- package/build/sdk-typescript/src/tools/search-index/SDKToolsDocSearch.d.ts +1 -1
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewGenerator.d.ts +17 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewMetadataGenerator.d.ts +8 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewReferenceInfoGenerator.d.ts +10 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewSegmentGenerator.d.ts +5 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewStyleGenerator.d.ts +5 -0
- package/build/sdk-typescript/src/tools/token-preview/TokenUtilPreviewTypes.d.ts +68 -0
- package/build/sdk-typescript/src/tools/token-transform/SDKToolsTokenTransform.d.ts +8 -12
- package/build/sdk-typescript/src/utils/TokenUtils.d.ts +113 -0
- package/build/sdk-typescript/src/utils/UnreachableCaseError.d.ts +3 -0
- package/build/supernova-sdk-typescript.js +1 -1
- package/build/supernova-sdk-typescript.js.map +1 -1
- package/package.json +9 -6
- package/build/sdk-typescript/src/core/SDKBrand.d.ts +0 -80
- package/build/sdk-typescript/src/core/SDKBrandWriter.d.ts +0 -29
- package/build/sdk-typescript/src/core/SDKDesignSystem.d.ts +0 -62
- package/build/sdk-typescript/src/core/SDKDesignSystemVersion.d.ts +0 -99
- package/build/sdk-typescript/src/core/SDKDocumentation.d.ts +0 -55
- package/build/sdk-typescript/src/core/SDKWorkspace.d.ts +0 -26
- package/build/sdk-typescript/src/model/support/SDKWorkspaceNPMRegistry.d.ts +0 -13
- package/build/sdk-typescript/src/model/tokens/SDKFontToken.d.ts +0 -16
- package/build/sdk-typescript/src/model/tokens/SDKGenericToken.d.ts +0 -18
- package/build/sdk-typescript/src/model/tokens/SDKMeasureToken.d.ts +0 -26
- package/build/sdk-typescript/src/model/tokens/SDKRadiusToken.d.ts +0 -18
- package/build/sdk-typescript/src/model/tokens/SDKTextToken.d.ts +0 -16
- /package/build/sdk-typescript/src/tests/{Accessors/Brand.spec.d.ts → Areas/AreaBatchUpdates.spec.d.ts} +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors/Components.spec.d.ts → Areas/AreaBrands.spec.d.ts} +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors/DesignSystem.spec.d.ts → Areas/AreaMe.spec.d.ts} +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors/DesignSystemVersion.spec.d.ts → Areas/AreaTokens.spec.d.ts} +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors/Documentation.spec.d.ts → Areas/AreaWorkspace.spec.d.ts} +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors/Supernova.spec.d.ts → Serialization/User.spec.d.ts} +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors → Serialization}/Workspace.spec.d.ts +0 -0
- /package/build/sdk-typescript/src/tests/{Accessors/Theme.spec.d.ts → Serialization/WorkspaceIPWhitelistSettings.spec.d.ts} +0 -0
|
@@ -1 +1 @@
|
|
|
1
|
-
export * from
|
|
1
|
+
export * from "./exports";
|
|
@@ -1,46 +1,52 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import {
|
|
5
|
-
import {
|
|
6
|
-
import {
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
1
|
+
import { AreaAssets } from "./areas/SDKAreaAssets";
|
|
2
|
+
import { AreaBrands } from "./areas/SDKAreaBrands";
|
|
3
|
+
import { AreaBulkOperations } from "./areas/SDKAreaBulkOperations";
|
|
4
|
+
import { AreaComponents } from "./areas/SDKAreaComponents";
|
|
5
|
+
import { AreaDataSources } from "./areas/SDKAreaDataSources";
|
|
6
|
+
import { AreaDesignSystems } from "./areas/SDKAreaDesignSystems";
|
|
7
|
+
import { AreaDocumentation } from "./areas/SDKAreaDocumentation";
|
|
8
|
+
import { AreaIntegrations } from "./areas/SDKAreaIntegrations";
|
|
9
|
+
import { AreaMe } from "./areas/SDKAreaMe";
|
|
10
|
+
import { AreaPipelines } from "./areas/SDKAreaPipelines";
|
|
11
|
+
import { AreaTokens } from "./areas/SDKAreaTokens";
|
|
12
|
+
import { AreaUsers } from "./areas/SDKAreaUsers";
|
|
13
|
+
import { AreaVersions } from "./areas/SDKAreaVersions";
|
|
14
|
+
import { AreaWorkspaces } from "./areas/SDKAreaWorkspaces";
|
|
15
|
+
import { DataBridgeRequestHook } from "./data/SDKDataBridge";
|
|
9
16
|
/** Main Supernova.io SDK object. Use this to connect to your data instance and retrieve workspace / design system / version from which you can access all neccessary data. */
|
|
10
17
|
export declare class Supernova {
|
|
11
|
-
private useResolutionCache;
|
|
12
18
|
private apiKey;
|
|
13
19
|
private apiUrl;
|
|
14
20
|
private apiVersion;
|
|
15
21
|
private requestHook;
|
|
16
|
-
private
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
22
|
+
private dataCore;
|
|
23
|
+
/** Get, create, update, manipulate or delete workspaces */
|
|
24
|
+
workspaces: AreaWorkspaces;
|
|
25
|
+
/** Get, create, update, manipulate or delete design systems */
|
|
26
|
+
designSystems: AreaDesignSystems;
|
|
27
|
+
/** Get, create, update, manipulate or delete versions */
|
|
28
|
+
versions: AreaVersions;
|
|
29
|
+
/** Get, create, update, manipulate or delete brands */
|
|
30
|
+
brands: AreaBrands;
|
|
31
|
+
/** Get, create, update, manipulate or delete tokens */
|
|
32
|
+
tokens: AreaTokens;
|
|
33
|
+
/** Get, create, update, manipulate or delete components */
|
|
34
|
+
components: AreaComponents;
|
|
35
|
+
/** Get, create, update, manipulate or delete assets */
|
|
36
|
+
assets: AreaAssets;
|
|
37
|
+
/** Get, create, update, manipulate or delete documentation items */
|
|
38
|
+
documentation: AreaDocumentation;
|
|
39
|
+
/** Get, create, update, manipulate or delete integrations */
|
|
40
|
+
integrations: AreaIntegrations;
|
|
41
|
+
/** Get, create, update, manipulate or delete users */
|
|
42
|
+
users: AreaUsers;
|
|
43
|
+
/** Get, create, update, manipulate or delete current user */
|
|
44
|
+
me: AreaMe;
|
|
45
|
+
/** Get, create, update, manipulate or delete pipelines */
|
|
46
|
+
pipelines: AreaPipelines;
|
|
47
|
+
/** Get, create, update, manipulate or delete data sources */
|
|
48
|
+
dataSources: AreaDataSources;
|
|
49
|
+
/** Get, create, update, manipulate or delete data from Supernova en masse */
|
|
50
|
+
bulkOperations: AreaBulkOperations;
|
|
51
|
+
constructor(apiKey: string, url?: string | null, requestHook?: DataBridgeRequestHook | null);
|
|
46
52
|
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { Asset } from "../../model/assets/SDKAsset";
|
|
2
|
+
import { RenderedAsset } from "../../model/assets/SDKRenderedAsset";
|
|
3
|
+
import { AssetFormat } from "../../model/enums/SDKAssetFormat";
|
|
4
|
+
import { AssetScale } from "../../model/enums/SDKAssetScale";
|
|
5
|
+
import { AssetGroup } from "../../model/groups/SDKAssetGroup";
|
|
6
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
7
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
8
|
+
export declare class AreaAssets {
|
|
9
|
+
/** Internal: Engine */
|
|
10
|
+
private dataCore;
|
|
11
|
+
constructor(dataCore: DataCore);
|
|
12
|
+
/** Fetches all remote assets in the version
|
|
13
|
+
* @param from - Remote version to fetch from
|
|
14
|
+
* @returns All assets in the specified version
|
|
15
|
+
*/
|
|
16
|
+
getAssets(from: RemoteVersionIdentifier): Promise<Array<Asset>>;
|
|
17
|
+
/** Fetches all remote asset groups in the version
|
|
18
|
+
* @param from - Remote version to fetch from
|
|
19
|
+
* @returns All asset groups in the specified version
|
|
20
|
+
*/
|
|
21
|
+
getAssetGroups(from: RemoteVersionIdentifier): Promise<Array<AssetGroup>>;
|
|
22
|
+
/** Renders all assets in this version and retrieves URLs from which assets can be downloaded as key-value.
|
|
23
|
+
*
|
|
24
|
+
* You can only render one combination of size/format with one request - use more requests if you need to render more. Assets that are rendered as "png" will use "scale" attribute, however, when the format is "svg" or "pdf", scale attribute is ignored and will always render the original size.
|
|
25
|
+
*
|
|
26
|
+
* Note that assets are not persistent and URLs will expire quickly - you must download them and store them locally / remotely and can never use this URL publicly as it won't work after a short time
|
|
27
|
+
* @param from - Remote version to fetch from
|
|
28
|
+
* @param assets - Assets to render
|
|
29
|
+
* @param groups - All asset groups in the version
|
|
30
|
+
* @param format - Format to render (png, svg, pdf)
|
|
31
|
+
* @param scale - Scale to render (1x, 2x, 3x, 4x)
|
|
32
|
+
* @returns All assets that were provided in the request, rendered in the specified format and scale
|
|
33
|
+
*/
|
|
34
|
+
getRenderedAssets(from: RemoteVersionIdentifier, assets: Array<Asset>, groups: Array<AssetGroup>, format: AssetFormat, scale: AssetScale): Promise<Array<RenderedAsset>>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { Brand } from "../../model/base/SDKBrand";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
import { RemoteBrandIdentifier, RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
4
|
+
export declare class AreaBrands {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Fetches all remote brands in the version
|
|
9
|
+
* @param from - Remote version to fetch from
|
|
10
|
+
* @returns All brands in the specified version
|
|
11
|
+
*/
|
|
12
|
+
getBrands(from: RemoteVersionIdentifier): Promise<Array<Brand>>;
|
|
13
|
+
/** Fetches a single brand
|
|
14
|
+
* @param from - Remote brand to fetch from
|
|
15
|
+
* @returns All brands in the specified version
|
|
16
|
+
*/
|
|
17
|
+
getBrand(from: RemoteBrandIdentifier): Promise<Brand>;
|
|
18
|
+
}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { Brand } from "../../model/base/SDKBrand";
|
|
2
|
+
import { ElementProperty } from "../../model/elements/SDKElementProperty";
|
|
3
|
+
import { TokenGroup } from "../../model/groups/SDKTokenGroup";
|
|
4
|
+
import { TokenTheme } from "../../model/themes/SDKTokenTheme";
|
|
5
|
+
import { AnyToken } from "../../model/tokens/SDKTokenValue";
|
|
6
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
7
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
8
|
+
export type TokenUpdateTransactionData = {
|
|
9
|
+
token: AnyToken;
|
|
10
|
+
tokenParent: TokenGroup;
|
|
11
|
+
tokenMode: "create" | "update";
|
|
12
|
+
propertyValuesToCreateOrUpdate?: Array<{
|
|
13
|
+
property: ElementProperty;
|
|
14
|
+
value: string;
|
|
15
|
+
}>;
|
|
16
|
+
propertyValuesToDelete?: Array<string>;
|
|
17
|
+
themesToUpdate?: Array<TokenTheme>;
|
|
18
|
+
};
|
|
19
|
+
export declare class AreaBulkOperations {
|
|
20
|
+
/** Internal: Engine */
|
|
21
|
+
private dataCore;
|
|
22
|
+
constructor(dataCore: DataCore);
|
|
23
|
+
/** Batch updates, creates or deletes token data from Supernova at once. Use this method to perform multiple operations at once instead of chaining single update operations. Batch routine runs everything in a single transaction, so either all operations succeed or all fail.
|
|
24
|
+
*
|
|
25
|
+
* WARNING: This method is not yet complete and only supports limited set of operations. Also, doesn't work as transation just yet.
|
|
26
|
+
* @param to - Remote version to write to
|
|
27
|
+
* @param data - Update information. All keys except token and its parent are optional and any combination of optional properties is allowed.
|
|
28
|
+
* @returns Nothing
|
|
29
|
+
*/
|
|
30
|
+
updateTokenData(to: RemoteVersionIdentifier, data: TokenUpdateTransactionData): Promise<Array<Brand>>;
|
|
31
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { Component } from "../../model/components/SDKComponent";
|
|
2
|
+
import { DesignComponent } from "../../model/components/SDKDesignComponent";
|
|
3
|
+
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
4
|
+
import { ElementProperty } from "../../model/elements/SDKElementProperty";
|
|
5
|
+
import { ComponentGroup } from "../../model/groups/SDKComponentGroup";
|
|
6
|
+
import { DesignComponentGroup } from "../../model/groups/SDKDesignComponentGroup";
|
|
7
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
8
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
9
|
+
export declare class AreaComponents {
|
|
10
|
+
/** Internal: Engine */
|
|
11
|
+
private dataCore;
|
|
12
|
+
constructor(dataCore: DataCore);
|
|
13
|
+
/** Fetches all remote components in the version
|
|
14
|
+
* @param from - Remote version to fetch from
|
|
15
|
+
* @returns All components in the specified version
|
|
16
|
+
*/
|
|
17
|
+
getComponents(from: RemoteVersionIdentifier): Promise<Array<Component>>;
|
|
18
|
+
/** Fetches all remote component groups in the version
|
|
19
|
+
* @param from - Remote version to fetch from
|
|
20
|
+
* @returns All component groups in the specified version
|
|
21
|
+
*/
|
|
22
|
+
getComponentGroups(from: RemoteVersionIdentifier): Promise<Array<ComponentGroup>>;
|
|
23
|
+
/** Fetches all remote design components in the version
|
|
24
|
+
* @param from - Remote version to fetch from
|
|
25
|
+
* @returns All design components in the specified version
|
|
26
|
+
*/
|
|
27
|
+
getDesignComponents(from: RemoteVersionIdentifier): Promise<Array<DesignComponent>>;
|
|
28
|
+
/** Fetches all remote design component groups in the version
|
|
29
|
+
* @param from - Remote version to fetch from
|
|
30
|
+
* @returns All design component groups in the specified version
|
|
31
|
+
*/
|
|
32
|
+
getDesignComponentGroups(from: RemoteVersionIdentifier): Promise<Array<DesignComponentGroup>>;
|
|
33
|
+
/** Retrieves all remote properties for tokens
|
|
34
|
+
* @param from - Remote version to fetch from
|
|
35
|
+
* @returns All component properties in the specified version
|
|
36
|
+
*/
|
|
37
|
+
getComponentProperties(from: RemoteVersionIdentifier): Promise<Array<ElementProperty>>;
|
|
38
|
+
/** Retrieves all remote property views for components
|
|
39
|
+
* @param from - Remote version to fetch from
|
|
40
|
+
* @returns All component views in the specified version
|
|
41
|
+
*/
|
|
42
|
+
getComponentDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
|
|
43
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import { Source } from "../../model/support/SDKSource";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
import { RemoteVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
4
|
+
export declare class AreaDataSources {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Retrieves a single source by its id
|
|
9
|
+
* @param from - Remote version to fetch from
|
|
10
|
+
* @returns Single data source
|
|
11
|
+
*/
|
|
12
|
+
getDataSourceById(from: RemoteVersionIdentifier, sourceId: string): Promise<Source>;
|
|
13
|
+
/** Retrieves all sources associated with specified design system
|
|
14
|
+
* @param from - Remote version to fetch from
|
|
15
|
+
* @returns All data sources in the specified version
|
|
16
|
+
*/
|
|
17
|
+
getDataSources(from: RemoteVersionIdentifier): Promise<Array<Source>>;
|
|
18
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
import { DesignSystem } from "../../model/base/SDKDesignSystem";
|
|
2
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
3
|
+
export declare class AreaDesignSystems {
|
|
4
|
+
/** Internal: Engine */
|
|
5
|
+
private dataCore;
|
|
6
|
+
constructor(dataCore: DataCore);
|
|
7
|
+
/** Fetches all design systems belonging to the workspace
|
|
8
|
+
* @param workspaceId - Workspace to fetch from
|
|
9
|
+
* @returns All design systems in the specified version
|
|
10
|
+
*/
|
|
11
|
+
designSystems(workspaceId: string): Promise<Array<DesignSystem>>;
|
|
12
|
+
/** Fetches a specific design system by its id
|
|
13
|
+
* @param designSystemId - Design system to fetch
|
|
14
|
+
* @returns Design system with the specified id
|
|
15
|
+
*/
|
|
16
|
+
designSystem(designSystemId: string): Promise<DesignSystem | null>;
|
|
17
|
+
}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { Documentation } from "../../model/base/SDKDocumentation";
|
|
2
|
+
import { DocumentationGroup } from "../../model/documentation/SDKDocumentationGroup";
|
|
3
|
+
import { DocumentationItem } from "../../model/documentation/SDKDocumentationItem";
|
|
4
|
+
import { DocumentationPage } from "../../model/documentation/SDKDocumentationPage";
|
|
5
|
+
import { ElementDataView } from "../../model/elements/SDKElementDataView";
|
|
6
|
+
import { ElementProperty } from "../../model/elements/SDKElementProperty";
|
|
7
|
+
import { ExporterCustomBlock } from "../../model/exporters/custom_blocks/SDKExporterCustomBlock";
|
|
8
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
9
|
+
import { RemoteVersionIdentifier, RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
10
|
+
export declare class AreaDocumentation {
|
|
11
|
+
/** Internal: Engine */
|
|
12
|
+
private dataCore;
|
|
13
|
+
constructor(dataCore: DataCore);
|
|
14
|
+
/** Fetches object containing the main information about the docs. This does not contain structure or content of the documentation
|
|
15
|
+
* @param from - Remote version to fetch from
|
|
16
|
+
* @returns Documentation object
|
|
17
|
+
*/
|
|
18
|
+
getDocumentation(from: RemoteWorkspaceVersionIdentifier): Promise<Documentation>;
|
|
19
|
+
/** Fetches all documentation structural entities, like groups and pages
|
|
20
|
+
* @param from - Remote version to fetch from
|
|
21
|
+
* @returns All documentation items
|
|
22
|
+
*/
|
|
23
|
+
getDocumentationItems(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationItem>>;
|
|
24
|
+
/** Fetches all documentation groups
|
|
25
|
+
* @param from - Remote version to fetch from
|
|
26
|
+
* @returns All documentation groups
|
|
27
|
+
*/
|
|
28
|
+
getDocumentationGroups(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationGroup>>;
|
|
29
|
+
/** Fetches all documentation pages
|
|
30
|
+
* @param from - Remote version to fetch from
|
|
31
|
+
* @returns All documentation pages
|
|
32
|
+
*/
|
|
33
|
+
getDocumentationPages(from: RemoteWorkspaceVersionIdentifier): Promise<Array<DocumentationPage>>;
|
|
34
|
+
/** Fetches all custom blocks that are defined in the active documentation exporter
|
|
35
|
+
* @param from - Remote version to fetch from
|
|
36
|
+
* @returns All custom blocks
|
|
37
|
+
*/
|
|
38
|
+
/** All custom blocks that were registered with the active exporter configuration */
|
|
39
|
+
getCustomBlocks(from: RemoteVersionIdentifier): Promise<Array<ExporterCustomBlock>>;
|
|
40
|
+
/** Retrieves all remote property definitions for documentation pages
|
|
41
|
+
* @param from - Remote version to fetch from
|
|
42
|
+
* @returns All property definitions in the specified version
|
|
43
|
+
*/
|
|
44
|
+
getPageProperties(from: RemoteVersionIdentifier): Promise<Array<ElementProperty>>;
|
|
45
|
+
/** Retrieves all remote property views for documentation pages
|
|
46
|
+
* @param from - Remote version to fetch from
|
|
47
|
+
* @returns All property views in the specified version
|
|
48
|
+
*/
|
|
49
|
+
getPageDataViews(from: RemoteVersionIdentifier): Promise<Array<ElementDataView>>;
|
|
50
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
2
|
+
export declare class AreaIntegrations {
|
|
3
|
+
/** Internal: Engine */
|
|
4
|
+
private dataCore;
|
|
5
|
+
constructor(dataCore: DataCore);
|
|
6
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with Figma
|
|
7
|
+
* @returns Figma OAuth URL
|
|
8
|
+
*/
|
|
9
|
+
getFigmaOAuthURL(): Promise<string>;
|
|
10
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with GitHub
|
|
11
|
+
* @returns GitHub OAuth URL
|
|
12
|
+
*/
|
|
13
|
+
getGitHubOAuthURL(): Promise<string>;
|
|
14
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with GitLab
|
|
15
|
+
* @returns GitLab OAuth URL
|
|
16
|
+
*/
|
|
17
|
+
getGitLabOAuthURL(): Promise<string>;
|
|
18
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with Bitbucket
|
|
19
|
+
* @returns Bitbucket OAuth URL
|
|
20
|
+
*/
|
|
21
|
+
getBitbucketOAuthURL(): Promise<string>;
|
|
22
|
+
/** Returns URL that can be used to authenticate current user (identified by the token) with Azure
|
|
23
|
+
* @returns Azure OAuth URL
|
|
24
|
+
*/
|
|
25
|
+
getAzureOAuthURL(): Promise<string>;
|
|
26
|
+
}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
import { User } from "../../model/users/SDKUser";
|
|
2
|
+
import { UserProfileUpdateModel } from "../../model/users/SDKUserProfile";
|
|
3
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
4
|
+
export declare class AreaMe {
|
|
5
|
+
/** Internal: Engine */
|
|
6
|
+
private dataCore;
|
|
7
|
+
constructor(dataCore: DataCore);
|
|
8
|
+
/** Fetches current user profile based on the API key provided to Supernova instance. */
|
|
9
|
+
me(): Promise<User>;
|
|
10
|
+
/** Invalidates all session keys for the current user, effectively logging out from all decises. */
|
|
11
|
+
logout(): Promise<void>;
|
|
12
|
+
/** Updates the current user based on the API key provided to Supernova instance. */
|
|
13
|
+
updateProfile(userId: string, profile: UserProfileUpdateModel): Promise<void>;
|
|
14
|
+
/** Updates the avatar of the current user */
|
|
15
|
+
updateAvatar(userId: string, avatar: File): Promise<void>;
|
|
16
|
+
/** Deletes the current user user based on the API key provided to Supernova instance. Also removes all owned workspaces and updates memberships where user belongs. */
|
|
17
|
+
deleteMe(userId: string): Promise<void>;
|
|
18
|
+
/** Checks whether user can be deleted. There are certain restrictions, like users who don't have all bills settled in their associated workspaces can't be deleted, for example */
|
|
19
|
+
canDeleteMe(userId: string): Promise<boolean>;
|
|
20
|
+
/** Updates the avatar of the current user */
|
|
21
|
+
deleteAvatar(userId: string): Promise<void>;
|
|
22
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { ExporterCustomBlockVariant } from "../../model/exporters/custom_blocks/SDKExporterCustomBlockVariant";
|
|
2
|
+
import { ExporterConfigurationProperty } from "../../model/exporters/custom_properties/SDKExporterConfigurationProperty";
|
|
3
|
+
import { Exporter } from "../../model/exporters/SDKExporter";
|
|
4
|
+
import { DataCore } from "../data/SDKDataCore";
|
|
5
|
+
import { RemoteWorkspaceVersionIdentifier } from "./SDKRemoteIdentifiers";
|
|
6
|
+
export declare class AreaPipelines {
|
|
7
|
+
/** Internal: Engine */
|
|
8
|
+
private dataCore;
|
|
9
|
+
constructor(dataCore: DataCore);
|
|
10
|
+
/** Fetches exporters belonging to workspace by id */
|
|
11
|
+
getExporters(workspaceId: string): Promise<Array<Exporter>>;
|
|
12
|
+
/** Fetches all custom configuration properties that specific exporter provides
|
|
13
|
+
* @param exporterId - Identifier of the exporter to fetch configuration for
|
|
14
|
+
* @param from - Remote version to fetch from
|
|
15
|
+
* @returns All custom blocks
|
|
16
|
+
*/
|
|
17
|
+
getExporterConfiguration(workspaceId: string, exporterId: string, designSystemId: string): Promise<Array<ExporterConfigurationProperty>>;
|
|
18
|
+
/** Fetches all custom variants that specific exporter provides
|
|
19
|
+
* @param workspaceId - Identifier of the workspace where the exporter is installed
|
|
20
|
+
* @param exporterId - Identifier of the exporter to fetch configuration for
|
|
21
|
+
* @returns All custom variants
|
|
22
|
+
*/
|
|
23
|
+
getExporterBlockVariants(workspaceId: string, exporterId: string): Promise<Array<ExporterCustomBlockVariant>>;
|
|
24
|
+
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline. You can request status of the build with associated `isBeingPublished` method. */
|
|
25
|
+
publish(to: RemoteWorkspaceVersionIdentifier): Promise<{
|
|
26
|
+
status: "Queued" | "InProgress" | "Failure";
|
|
27
|
+
jobId: string | null;
|
|
28
|
+
exporterId: string | null;
|
|
29
|
+
}>;
|
|
30
|
+
/** Publish documentation. This queues a build on Supernova's server that will be processed by the asynchronous CI/CD pipeline. You can request status of the build with associated `isBeingPublished` method. */
|
|
31
|
+
isPublishing(to: RemoteWorkspaceVersionIdentifier): Promise<{
|
|
32
|
+
status: "InProgress" | "Idle";
|
|
33
|
+
jobId: string | null;
|
|
34
|
+
exporterId: string | null;
|
|
35
|
+
}>;
|
|
36
|
+
}
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
import { BlurToken, BlurType, BorderPosition, BorderStyle, BorderToken, GradientToken, GradientType, OpacityToken, RadiusToken, ShadowToken, ShadowType, TextCaseToken, TextDecorationToken, TokenTheme, TypographyToken, VisibilityToken } from "../../exports";
|
|
2
|
+
import { ColorToken } from "../../model/tokens/SDKColorToken";
|
|
3
|
+
import { BorderWidthToken, DimensionToken, DurationToken, FontSizeToken, LetterSpacingToken, LineHeightToken, ParagraphSpacingToken, SizeToken, SpaceToken, ZIndexToken } from "../../model/tokens/SDKDimensionToken";
|
|
4
|
+
import { FontFamilyToken, FontWeightToken, ProductCopyToken, StringToken } from "../../model/tokens/SDKStringToken";
|
|
5
|
+
import { AnyMultiLayerToken, AnySingleLayerToken, AnyToken, BorderWidthTokenValue, ColorTokenValue, ColorValue, DimensionTokenValue, DurationTokenValue, FontFamilyTokenValue, FontSizeTokenValue, FontWeightTokenValue, LetterSpacingTokenValue, LineHeightTokenValue, OpacityTokenValue, ParagraphSpacingTokenValue, ProductCopyTokenValue, RadiusTokenValue, RawValue, SizeTokenValue, SpaceTokenValue, StringTokenValue, TextCaseTokenValue, TextDecorationTokenValue, VisibilityTokenValue, ZIndexTokenValue } from "../../model/tokens/SDKTokenValue";
|
|
6
|
+
export declare class AreaTokenValues {
|
|
7
|
+
/** Creates a new theme with updated overrides */
|
|
8
|
+
tokenThemeByUpdatingOverride(theme: TokenTheme, override: AnyToken): TokenTheme;
|
|
9
|
+
/** Creates a new theme with removed override */
|
|
10
|
+
tokenThemeByRemovingOverride(theme: TokenTheme, tokenId: string): TokenTheme;
|
|
11
|
+
/** Creates a new color token with updated .color value */
|
|
12
|
+
colorTokenByUpdatingColor(token: ColorToken, newValue: ColorValue | ColorToken): ColorToken;
|
|
13
|
+
/** Creates a new color token with updated .opacity value */
|
|
14
|
+
colorTokenByUpdatingOpacity(token: ColorToken, newValue: number | OpacityToken): ColorToken;
|
|
15
|
+
/** Creates a new blur token with updated .type value */
|
|
16
|
+
blurTokenByUpdatingType(token: BlurToken, newValue: BlurType): BlurToken;
|
|
17
|
+
/** Creates a new blur token with updated .radius value */
|
|
18
|
+
blurTokenByUpdatingRadius(token: BlurToken, newValue: RawValue<DimensionTokenValue> | RadiusToken): BlurToken;
|
|
19
|
+
/** Creates a new typography token with updated .fontFamily value */
|
|
20
|
+
typographyTokenByUpdatingFontFamily(token: TypographyToken, newValue: RawValue<FontFamilyTokenValue> | FontFamilyToken): TypographyToken;
|
|
21
|
+
/** Creates a new typography token with updated .fontWeight value */
|
|
22
|
+
typographyTokenByUpdatingFontWeight(token: TypographyToken, newValue: RawValue<FontWeightTokenValue> | FontWeightToken): TypographyToken;
|
|
23
|
+
/** Creates a new typography token with updated .fontSize value */
|
|
24
|
+
typographyTokenByUpdatingFontSize(token: TypographyToken, newValue: RawValue<FontSizeTokenValue> | FontSizeToken): TypographyToken;
|
|
25
|
+
/** Creates a new typography token with updated .letterSpacing value */
|
|
26
|
+
typographyTokenByUpdatingLetterSpacing(token: TypographyToken, newValue: RawValue<LetterSpacingTokenValue> | LetterSpacingToken): TypographyToken;
|
|
27
|
+
/** Creates a new typography token with updated .lineHeight value */
|
|
28
|
+
typographyTokenByUpdatingLineHeight(token: TypographyToken, newValue: RawValue<LineHeightTokenValue> | LineHeightToken): TypographyToken;
|
|
29
|
+
/** Creates a new typography token with updated .paragraphSpacing value */
|
|
30
|
+
typographyTokenByUpdatingParagraphSpacing(token: TypographyToken, newValue: RawValue<ParagraphSpacingTokenValue> | ParagraphSpacingToken): TypographyToken;
|
|
31
|
+
/** Creates a new typography token with updated .paragraphSpacing value */
|
|
32
|
+
typographyTokenByUpdatingParagraphIndent(token: TypographyToken, newValue: RawValue<ParagraphSpacingTokenValue> | ParagraphSpacingToken): TypographyToken;
|
|
33
|
+
/** Creates a new border token with updated .position value */
|
|
34
|
+
typographyTokenByUpdatingTextDecoration(token: TypographyToken, newValue: RawValue<TextDecorationTokenValue> | TextDecorationToken): TypographyToken;
|
|
35
|
+
/** Creates a new border token with updated .color value. Do note, opacity is ignored */
|
|
36
|
+
borderTokenByUpdatingColor(token: BorderToken, newValue: ColorValue | ColorToken): BorderToken;
|
|
37
|
+
/** Creates a new border token with updated color.opacity value */
|
|
38
|
+
borderTokenByUpdatingOpacity(token: BorderToken, newValue: number | OpacityToken): BorderToken;
|
|
39
|
+
/** Creates a new border token with updated .width value */
|
|
40
|
+
borderTokenByUpdatingWidth(token: BorderToken, newValue: RawValue<BorderWidthTokenValue> | BorderWidthToken): BorderToken;
|
|
41
|
+
/** Creates a new border token with updated .position value */
|
|
42
|
+
borderTokenByUpdatingPosition(token: BorderToken, newValue: BorderPosition): BorderToken;
|
|
43
|
+
/** Creates a new border token with updated .style value */
|
|
44
|
+
borderTokenByUpdatingStyle(token: BorderToken, newValue: BorderStyle): BorderToken;
|
|
45
|
+
/** Creates a new dimension token with updated value */
|
|
46
|
+
dimensionTokenByUpdatingValue(token: DimensionToken, newValue: RawValue<DimensionTokenValue>): DimensionToken;
|
|
47
|
+
/** Creates a new size token with updated value */
|
|
48
|
+
sizeTokenByUpdatingValue(token: SizeToken, newValue: RawValue<SizeTokenValue>): SizeToken;
|
|
49
|
+
/** Creates a new space token with updated value */
|
|
50
|
+
spaceTokenByUpdatingValue(token: SpaceToken, newValue: RawValue<SpaceTokenValue>): SpaceToken;
|
|
51
|
+
/** Creates a new opacity token with updated value */
|
|
52
|
+
opacityTokenByUpdatingValue(token: OpacityToken, newValue: RawValue<OpacityTokenValue>): OpacityToken;
|
|
53
|
+
/** Creates a new font size token with updated value */
|
|
54
|
+
fontSizeTokenByUpdatingValue(token: FontSizeToken, newValue: RawValue<FontSizeTokenValue>): FontSizeToken;
|
|
55
|
+
/** Creates a new font size token with updated value */
|
|
56
|
+
lineHeightTokenByUpdatingValue(token: LineHeightToken, newValue: RawValue<LineHeightTokenValue>): LineHeightToken;
|
|
57
|
+
/** Creates a new letter spacing token with updated value */
|
|
58
|
+
letterSpacingTokenByUpdatingValue(token: LetterSpacingToken, newValue: RawValue<LetterSpacingTokenValue>): LetterSpacingToken;
|
|
59
|
+
/** Creates a new paragraph spacing token with updated value */
|
|
60
|
+
paragraphSpacingTokenByUpdatingValue(token: ParagraphSpacingToken, newValue: RawValue<ParagraphSpacingTokenValue>): ParagraphSpacingToken;
|
|
61
|
+
/** Creates a new border width token with updated value */
|
|
62
|
+
borderWidthTokenByUpdatingValue(token: BorderWidthToken, newValue: RawValue<BorderWidthTokenValue>): BorderWidthToken;
|
|
63
|
+
/** Creates a new radius token with updated value */
|
|
64
|
+
radiusTokenByUpdatingValue(token: RadiusToken, newValue: RawValue<RadiusTokenValue>): RadiusToken;
|
|
65
|
+
/** Creates a new duration token with updated value */
|
|
66
|
+
durationTokenByUpdatingValue(token: DurationToken, newValue: RawValue<DurationTokenValue>): DurationToken;
|
|
67
|
+
/** Creates a new z-index token with updated value */
|
|
68
|
+
zIndexTokenByUpdatingValue(token: ZIndexToken, newValue: RawValue<ZIndexTokenValue>): ZIndexToken;
|
|
69
|
+
/** Creates a new string token with updated value */
|
|
70
|
+
stringTokenByUpdatingValue(token: StringToken, newValue: RawValue<StringTokenValue>): StringToken;
|
|
71
|
+
/** Creates a new product copy token with updated value */
|
|
72
|
+
productCopyTokenByUpdatingValue(token: ProductCopyToken, newValue: RawValue<ProductCopyTokenValue>): ProductCopyToken;
|
|
73
|
+
/** Creates a new font family token with updated value */
|
|
74
|
+
fontFamilyTokenByUpdatingValue(token: FontFamilyToken, newValue: RawValue<FontFamilyTokenValue>): FontFamilyToken;
|
|
75
|
+
/** Creates a new font weight token with updated value */
|
|
76
|
+
fontWeightTokenByUpdatingValue(token: FontWeightToken, newValue: RawValue<FontWeightTokenValue>): FontWeightToken;
|
|
77
|
+
/** Creates a new text case token with updated value */
|
|
78
|
+
textCaseTokenByUpdatingValue(token: TextCaseToken, newValue: RawValue<TextCaseTokenValue>): TextCaseToken;
|
|
79
|
+
/** Creates a new text case token with updated value */
|
|
80
|
+
textDecorationTokenByUpdatingValue(token: TextDecorationToken, newValue: RawValue<TextDecorationTokenValue>): TextDecorationToken;
|
|
81
|
+
/** Creates a new visibility token with updated value */
|
|
82
|
+
visibilityTokenByUpdatingValue(token: VisibilityToken, newValue: RawValue<VisibilityTokenValue>): VisibilityToken;
|
|
83
|
+
/** Creates a new shadow token with one new extra layer added at the end of all layers */
|
|
84
|
+
shadowTokenByAddingLayer(token: ShadowToken): ShadowToken;
|
|
85
|
+
/** Creates a new shadow token by removing one of the layers */
|
|
86
|
+
shadowTokenByRemovingLayer(token: ShadowToken, layerIndex: number): ShadowToken;
|
|
87
|
+
/** Creates a new shadow token with updated .color value. Do note, opacity is ignored */
|
|
88
|
+
shadowTokenByUpdatingColor(token: ShadowToken, layerIndex: number, newValue: ColorValue | ColorToken): ShadowToken;
|
|
89
|
+
/** Creates a new shadow token with updated .color value */
|
|
90
|
+
shadowTokenByUpdatingOpacity(token: ShadowToken, layerIndex: number, newValue: number | OpacityToken): ShadowToken;
|
|
91
|
+
/** Creates a new shadow token with updated .x value */
|
|
92
|
+
shadowTokenByUpdatingX(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
93
|
+
/** Creates a new shadow token with updated .y value */
|
|
94
|
+
shadowTokenByUpdatingY(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
95
|
+
/** Creates a new shadow token with updated .radius value */
|
|
96
|
+
shadowTokenByUpdatingRadius(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
97
|
+
/** Creates a new shadow token with updated .spread value */
|
|
98
|
+
shadowTokenByUpdatingSpread(token: ShadowToken, layerIndex: number, newValue: number): ShadowToken;
|
|
99
|
+
/** Creates a new shadow token with updated .type value */
|
|
100
|
+
shadowTokenByUpdatingType(token: ShadowToken, layerIndex: number, newValue: ShadowType): ShadowToken;
|
|
101
|
+
/** Creates a new gradient token with updated .to value */
|
|
102
|
+
gradientTokenByUpdatingTo(token: GradientToken, layerIndex: number, newValue: {
|
|
103
|
+
x: number;
|
|
104
|
+
y: number;
|
|
105
|
+
}): GradientToken;
|
|
106
|
+
/** Creates a new gradient token with updated .from value */
|
|
107
|
+
gradientTokenByUpdatingFrom(token: GradientToken, layerIndex: number, newValue: {
|
|
108
|
+
x: number;
|
|
109
|
+
y: number;
|
|
110
|
+
}): GradientToken;
|
|
111
|
+
/** Creates a new gradient token with updated .to value */
|
|
112
|
+
gradientTokenByUpdatingType(token: GradientToken, layerIndex: number, newValue: GradientType): GradientToken;
|
|
113
|
+
/** Creates a new gradient token with updated .aspectRatio value */
|
|
114
|
+
gradientTokenByUpdatingAspectRatio(token: GradientToken, layerIndex: number, newValue: number): GradientToken;
|
|
115
|
+
/** Creates a new gradient token with updated .to value */
|
|
116
|
+
gradientTokenByUpdatingStops(token: GradientToken, layerIndex: number, newValue: Array<{
|
|
117
|
+
position: number;
|
|
118
|
+
color: ColorTokenValue | ColorToken;
|
|
119
|
+
}>): GradientToken;
|
|
120
|
+
/** Builds the gradient stop data from the elementary values */
|
|
121
|
+
private gradientStopsFromRawData;
|
|
122
|
+
/** Creates a new token where value is reference to the provided token. Token and reference must be of the same type */
|
|
123
|
+
tokenByReferencing<T extends AnyToken>(token: T, reference: T): T;
|
|
124
|
+
/** Creates a new multilayer token where one of the layers is reference to the provided token. Token and reference must be of the same type */
|
|
125
|
+
multilayerTokenByReferencing<T extends AnyMultiLayerToken>(token: T, layerIndex: number, reference: T): T;
|
|
126
|
+
/** Creates a new token where value is raw, but taken from the previously referenced token. Token must have had reference before */
|
|
127
|
+
tokenByDisconnectingReference<T extends AnySingleLayerToken>(token: T): T;
|
|
128
|
+
/** Creates a new multilayer token where one of the layers value is raw, but taken from the previously referenced token. That layer must have had reference before */
|
|
129
|
+
multilayerTokenByDisconnectingReference<T extends AnySingleLayerToken>(token: T, layerIndex: number): T;
|
|
130
|
+
/** Checks if token as a whole is a reference to another token */
|
|
131
|
+
isReferencedToken(token: AnySingleLayerToken): boolean;
|
|
132
|
+
/** Checks if a token layer of multilayer token is a reference to another token */
|
|
133
|
+
isReferencedMultilayerTokenLayer(token: AnyMultiLayerToken, layerIndex: number): boolean;
|
|
134
|
+
/** Checks if a token was imported from some foreign source. Not imported tokens were always created in Supernova */
|
|
135
|
+
isTokenImported(token: AnyToken): boolean;
|
|
136
|
+
private checkNotReference;
|
|
137
|
+
private rawOrReferencedDimensionValue;
|
|
138
|
+
private rawOrReferencedStringValue;
|
|
139
|
+
private validateLayerAccess;
|
|
140
|
+
}
|